There are over 100 variables that the user can set to customize either the calendars generated or the behavior of FWCalendar while the calendar is being created.

User variables are contained in localized preferences files. This allows you to keep your variables separate so you don't have to change them every time the macros are updated. No values need to be entered in the preferences file if the values listed as default are acceptable; if the default value is not acceptable, enter the desired values in the preferences file.

Changes made to the preferences file using the variable editor are saved, but not to the preferences file itself (this file is never modified by the program). Should you change any values in the preferences file, you will need to select the "Load" button in the variable editor and re-load the preferences file for the changes to be read. Note that this will cause any previous changes made with the variable editor to be lost, so it is always best to keep your preferred default values set in the preferences file.

Both FWCalendar and FWCAddEvent use the same preferences file for initializing variables, so the preferences file should not be changed between using FWCalendar and FWCAddEvent. See notes on the Variable Editor for more details.

There should be no need to change variables in the macro itself.

All font sizes are computed according to the size of the TextArea and the MiniCal heights relative to the area available to the calendar. The font used for dates, highlights, and FWCAddEvent text can have the width adjusted.

The following rules MUST be followed in creating or modifying a preferences file:

Any comments must be fully contained in the same line.

Variable names must be separated from the '=' by at least one space.

The variables must be followed by the line: /* End Pass One - DO NOT DELETE THIS LINE!!! */

Localization strings
Localized preferences files are included with the distribution. Each file includes all of the currently used translation strings (ending in '$'). If you would like to include your language, please contact the author. If you would like to improve the translation strings for your language, please email the author the updated preferences file.

Variables
Special variable pairs are available to allow variations in sentence structure for different languages and to customize parts of the calendars. The variable pairs and their defaults are:

GeneratingM$ = 'Generating %s %s calendar'
GenMVars = 'Month.Month EnteredYear'

GeneratingY$ = 'Generating %s calendar'
GenYVars = 'EnteredYear'

Header$ = '%s %s'
HeaderVars = 'Month.Month EnteredYear'

SubHeader$ = ''
SubHeaderVars = (undefined)

Each of the %s place holders in the first of each variable pair is replaced by one of the internal variables identified in the second of each variable pair. Although any internal variable can be used, the most useful variables are:

Month for the number of the calendar month
Month.Month for the name of the calendar month
EnteredYear for the calendar year

With a little knowledge of ARexx, variations of these variables can be created:

left(Month.Month,3) for the 3-letter abbreviation of the calendar month
right(EnteredYear,2) for the last two digits of the calendar year

Note: the replacement variables must not contain any spaces.

The defaults result in requesters saying 'Generating August 2000 calendar' and 'Generating 2000 calendar', and a calendar header of 'August 2000' (depending on the selected month/year, of course), respectively.

 

Miscellaneous Variables
AddEventRows	The maximum number of rows of FWCAddEvent text allowed on each day; affects the point size of the FWCAddEvent font (see note 3) Values: any decimal number (larger = smaller text) Default: 9
AdjustDST	Take daylight savings time changes into account when using SunCalc (see note 3) Values: 0 = don't adjust, 1 = adjust (requires RexxTricks.library) Default: 1
AdventHighlights	Insert Advent Sundays. Text used is changed by adding Advent$.1 through Advent$.4 to the FWCTranslations.txt file. Values: 0 = don't include, 1 = include Default: 1
BelzierFactor	Adjust the "curvature" of moon phases (Final Writer only) (see note 3) Values: any decimal number (smaller = more angular; larger = more square) Default: 0.55
CalendarBorder	Percentage of calendar width to offset the calendar outline box (see notes 2 & 3) Values: Decimal number (0 = no outline box) Default: 0
CalendarShadow	Percentage of calendar width to offset the calendar shadow box (see notes 2 & 3) Values: Decimal number (0 = no shadowbox) Default: 0
CenterHistory	Flag indicating whether or not the history entry should be centered Values: 0 = don't center, 1 = center Default: 1
CenterMiniDates	Flag indicating whether or not the dates in the mini-calendars should be centered or left-adjusted Values: 0 = don't center, 1 = center Default: 1
CenterRandom	Flag indicating whether or not the random entry should be centered Values: 0 = don't center, 1 = center Default: 1
CornerRadius	Cause day-boxes to have rounded corners rather than be rectangular boxes. If Final Writer is the host application, then don't use with DoDateBox (see note 3) Values: FW = Actual radius fixed by FW, but adjust this value to shift dates away from corners PGS = Any small decimal number (represents percentage of day-cell height) (see note 3) Default: 0
CountPartialWeek	Flag indicating whether or not the first whole week should be counted as week one, or the first (possibly partial) week should be counted as week one. Values: 0 = Count whole week only, 1 = Count partial week Default: 0
DateBoxImage	The image to use around the date number when BoxDates is set. If set to 'Default' then a rectangle will be drawn Values: See Images for format. Default: Default
DateOffset	Percent of box width to offset dates from edge of box (see notes 2 & 3) Values: any decimal number Default: 2
DoHide	Hide PageStream window while rendering (see Tips & Solutions) Values: 0 = don't hide, 1 = hide Default: 0
DSTEnd	Set the ending date for Daylight Saving Time (put the cursor in the text field and press the "Enter" key; the Highlight Editor will be brought up enabling the date to be set) Values: Any valid floating date Default: The last Saturday in March
DSTStart	Set the starting date for Daylight Saving Time (put the cursor in the text field and press the "Enter" key; the Highlight Editor will be brought up enabling the date to be set) Values: Any valid floating date Default: The last Saturday in October
EndWeek	Day of the week to use in the last calendar column. When used in conjunction with StartWeek, a range of days (e.g., Monday through Friday) can be printed. Values: -1 = Day before StartWeek 0 = Sunday 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday Default: -1 (day before StartWeek)
FinalView	Sets the magnification percent of the calendar after it is created (see notes 2 & 3) Values: FW = Any whole number (20 - 400) PGS = Any number (5 - 3000) Default: 75
ForceBGUI	Force BGUI to be used as the GUI (if you can't get the ClassAct GUI to work for some reason, you may have to set ForceBGUI = 1 in your preference file using a text editor. Values: 0 = don't force, 1 = force use of BGUI Default: 0
GenMVars	The variables substituted for the %s placeholders in GeneratingM$ (found in the FWCTranslations.txt file) Values: Any internal FWCalendar variable Default: 'Month.Month EnteredYear'
GenYVars	The variables substituted for the %s placeholders in GeneratingY$ (found in the FWCTranslations.txt file) Values: Any internal FWCalendar variable Default: 'EnteredYear'
GfxApp	The name of the graphics application used to determine the datatype, width, and height of images to be inserted (set to FWCalendar.rexx to use the internal parser) Values: see Images Default: 'FWCalendar'
GfxAppPath	Path to graphics application Values: : or / terminated path to the graphics application; don't include the application name with the path! Default: None
HeaderLoc	Percent down the text area (TTextArea or WTextArea, as appropriate) the header (month/year) will be placed (see notes 2 & 3) Values: any decimal number Default: 25
HeaderSize	Percent of text area (TTextArea or WTextArea, as appropriate) to be used for the header text (Header$) (see notes 2 & 3) Values: any decimal number Default: 50
Header$	The text used for the header, with %s placeholders for the varibles found in HeaderVars Values: Any text Default: '%s %s'
HeaderVars	The variables substituted for the %s placeholders in Header$ Values: Any internal FWCalendar variable Default: 'Month.Month EnteredYear'
HelpTime	Set the time (approximately in seconds) that Help balloons remain open (see note 3) Values: Any decimal number Default: 4
HighlightRows	The maximum number of rows of Highlight text desired in each day; affects point size of Highlight font (see note 3) Values: any decimal number (larger = smaller text) Default: 9
HostScreen	Identifies the public screen to be used for requesters (also see Tips & Solutions) Values: The case-sensitive name of the public sreen to use for requesters. Default: None
Image.	Images to be used in place of boxes in several places. Default: '' Advent - Inserted on Advent Sundays. DateBox - Surrounds the date on the main calendar; the "Box Date" option must also be set. Image must be actual size; it will not be scaled DateSquare - Surrounds the day on the main calendar, scaled to fit the confines of the area allowed. Set the Line.Grid and other line-drawing colors to >Clear< for best results. Holiday - Indicates Holiday highlights on the minicalendar. Image must be actual size; it will not be scaled Special - Indicates Special highlights on the minicalendar. Image must be actual size; it will not be scaled
ImageClass.	Image files to be used for common events (see Images) (see note 1) Vaules: The name of an image file Default: None
JulianSepChar	Character(s) used between current Julian day and Julian days remaining when both values are printed in the same location. Values: Any printable character(s) Default: '/'
LaunchM	Variable to be INTERPRETed upon completion of monthly calendar Values: See Launch Program Default: None
LaunchY	Variable to be INTERPRETed upon completion of yearly calendar Values: See Launch Program Default: None
Leading	The height of each text line expressed as a percentage of the font height (see notes 2 & 3) Values: any decimal number (larger = lines farther apart) Default: 100
Limit.	Limits the day on which the item will be printed Values: 0 to 6 to limit the item to a specific day, 7 to print it on all days. 0 = Sunday 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday Julian - Default: 7 Sunrise - Default: 7
MagnifyExtras	The font size of the extras (sunrise, julian, etc) text; expressed as a percentage of the internally calculated highlight font size (see notes 2 & 3) Values: any decimal number (<100 will shrink extras text, >100 will make extras text larger) Default: 100
Marker.	Indicators for Special and Holiday highlights Values: Any single character (other than the asterisk (*)) that won't otherwise end up at the end of a highlight. Holiday - Default: # Special - Default: ~
MaxImgHeight	Maximum percentage of boxheight to be used for images (see notes 2 & 3) Values: Decimal number less than 1 Default: 75
MaxImgWidth	Maximum percentage of boxwidth to be used for images (see notes 2 & 3) Values: Decimal number less than 1 Default: 75
MiniCalHeight	Percentage of text area height used for minicals (see notes 2 & 3) Values: any decimal number Default: 60
MiniCalSpacing	Percentage of print width placed between full-year minicals (see notes 2 & 3) Values: any decimal number Default: 5
MiniCalWidth	Percent of the minical height (MiniCalHeight) to use for the width of the minicals (see notes 2 & 3) Values: any decimal number Default: 200
MinHistoryWidth	The smallest font width allowed when compressing history entries, expressed as a percent of the normal width (see notes 2 & 3) Values: any decimal number (lower = more compression allowed) Default: 70
MinRandomWidth	The smallest font width allowed when compressing random entries, expressed as a percent of the normal width (see notes 2 & 3) Values: any decimal number (lower = more compression allowed) Default: 70
MinWidth	The smallest font width allowed when compressing highlights and events, expressed as a percent of the normal width (see notes 2 & 3) Values: any decimal number (lower = more compression allowed) Default: 80
MoonRadius	Percentage of boxheight to use for moon image (see notes 2 & 3) Values: Decimal number less than 100 Default: 10
PageHeight	Height of paper in default units (see note 3) Values: any decimal number in your default units Default: FW = read from preferences PGS = 11.0
PageWidth	Width of paper in default units (see note 3) Values: any decimal number in your default units Default: FW = read from preferences PGS = 8.5
PhaseType	Determines whether the moon phases are shown on each day, or only when the quarter-phases occur Values: D for daily phases or Q for quarter-phases Default: Q
PrefsName	Sets the title shown for the current preference file Values: Any text (underscores cause the following character to be underlined) Default: The path and name of the preference file
ShadowType	Determines the type of shadow used Values: 'P' = Partial (only shadow edges drawn)   'F' = Full (complete shadow box drawn) Default: 'P'
ShiftLMini	Distance to shift the left minical in your default units (see note 3) Values: any number (- = shift left, + = shift right) Default: 0
ShiftRMini	Distance to shift the right minical in your default units (see note 3) Values: any number (- = shift left, + = shift right) Default: 0
StartWeek	Day of the week to use in the first calendar column. When used in conjunction with EndWeek, a range of days (e.g., Monday through Friday) can be printed. Values: 0 = Sunday 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday Default: 0 (Sunday)
StretchDateH	Percent of calculated date height to use for dates, can give "drop cap" effect (see notes 2 & 3) Values: Any number, best 100 - 400 Default: 100
StretchDateW	Percent of calculated date width to use for dates (see notes 2 & 3) Values: Any number, best 100 - 400 Default: 100
SubHeaderLoc	Percent down the text area (TTextArea or WTextArea, as appropriate) the subheader will be placed. Note that the subheader can be place above the header (see notes 2 & 3) Values: any decimal number Default: 0
SubHeaderSize	Percent of text area (TTextArea or WTextArea, as appropriate) to be used for the subheader text (SubHeader$) (see notes 2 & 3) Values: any decimal number Default: 0
SubHeader$	The text used for the subheader, with %s placeholders for the varibles found in SubHeaderVars Values: Any text Default: ''
SubHeaderVars	The variables substituted for the %s placeholders in SubHeader$ Values: Any internal FWCalendar variable Default: ''
SunCalcPath	Path to SunCalc Values: : or / terminated path to SunCalc; don't include the application name with the path! Default: None
SunRiseSepChar	Character(s) used between sunrise time and sunset time when both values are printed in the same location. Values: Any printable character(s) Default: '/'
Text.	Text strings to be included before the value (see note 1) Default: '' Julian - Julian days WeekNumber - Sequential week number Sunrise - Sunrise time Sunset - Sunset time
TextAdj	Percent of font height to lower inserted text when Final Writer is the host application; takes into account that Final Writer text is located according to the baseline and not the top or bottom of the text block. TextAdj represents how far down the font the baseline is located (see notes 2 & 3) Values: any decimal number Default: 77
TTextArea	Percent of print height used for top of tall calendar (see notes 2 & 3) Values: any decimal number Default: 15
WeekdaySize	The percent of available vertical space used for the names of the weekdays (see notes 2 & 3) Values: any decimal number Default: 50
WTextArea	Percent of print height used for top of wide calendar (see notes 2 & 3) Values: any decimal number Default: 20

Note 1: These variables will appear as a combination of the "stem" and a particular variable, such as Color.Date

Note 2: All percents are such that 1 = 1% and 100 = 100%